How to create and edit an Editor

A Sapphire Editor is, for all intents and purposes, a Global Replace tool. It enables authorized users to search for and select one or more records and:

• Update a value in a field (e.g. perhaps replacing variations of a value with an approved value).
• Attach the selected records to another record.

When a Programme Lead accesses a project, any data entry Forms and Editors already created will display, along with an option to add a Form, Editor or Statistics tool:

1. To create a new Editor, click in the Editors section:



2. Complete the top four fields:

Title	Give the Editor a descriptive name. This name will be listed in the Editors section for authorized users.
Description	Add a description of the Editor or details about how to use it. When users access the Editor, an Information icon will display alongside the title: Clicking the icon will display a pop-up with the description.
Identifier	In the Identifier field, add a descriptive identifier (or leave blank and an alphanumeric identifier will be assigned automatically). For the most part it is irrelevant whether the identifier is an alphanumeric value provided by the system or a label provided by the Programme Lead as it is only referenced behind the scenes by various components of Sapphire, or used to construct the URL for the Form. If you want a more human-readable URL, assign an identifier.
Table	The module that holds the records to be modified. Users will search for records in this module and select one or more records which will be updated by the Editor.

3. Specify permissions.

See How to specify permissions for details.

4. Complete the Source field:

   Column

   The column that holds data which users will search in order to select records to be updated. For example, data entry users may have used the Notes field of the Catalogue module to store a range of details about objects, including an object's condition using keywords such as Excellent, Poor, etc. Setting the Source column to NotNotes will allow users to search NotNotes for the keywords and select matching records.

   It is possible to filter values returned from Column.

   1. Click .
   2. Specify a Column and Value to filter results displayed in the Source pane of the Editor.

   Records displayed in the Source pane of the Editor must meet the criteria specified in Filters.

5. Complete the Destination fields.

The Destination is the field that will be updated by the Editor:

Column	The name of the field in Table specified above which will be updated by the Editor.
Update only empty values	This option operates in conjunction with Column. When the Only Empty checkbox is ticked, if the Destination field is already populated, it is not updated by this Editor.
Use when updating attachments	These two fields auto-complete if Column is an attachment field:
	Reference Table	The target module. The attachment will be made to a record in this module.
	Reference Column	The data that will display in the Target pane of the Editor to assist users to identify and select the correct attachment record. By default, SummaryData is displayed. This can be changed to another field in Reference Table if necessary.
Use when replacing / cleaning values in a field	Type	Options are: date The date picker pop-up will display when the cursor is placed in the field in the Target pane of the Editor. text Values drawn from the Lookup specified will be auto-suggested as a value is keyed into the text box in the Target pane of the Editor.
	Hint	A hint to users. Text entered here will display in the text box in the Target pane of the Editor.
	Lookup	The name of a Lookup List. Values from this list will be listed in the Target pane of the Editor.
	Level	If the Lookup List is a multi-level hierarchy, use the Level field to specify which level of the hierarchy to display.

It is possible to filter values returned from Reference Column.

Click to specify a Column and Value to filter results displayed in the Target pane of the Editor.



6. Save the Editor.